[Search][Query Rules UI] Test in console and delete ruleset from details page #221350

JoseLuisGJ · 2025-05-23T10:17:12Z

Summary

Adding Test in Console and Delete from the Ruleset details page:

CleanShot.2025-05-23.at.12.20.12.mp4

Test in Console example populating data from the ruleset selected:

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
Flaky Test Runner was used on any tests changed
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

See some risk examples
...

JoseLuisGJ · 2025-05-26T09:45:55Z

@elasticmachine merge upstream

…-fix'

Samiul-TheSoccerFan

LGTM, left some comments and one performance improvement suggestion

x-pack/solutions/search/plugins/search_query_rules/public/hooks/use_run_query_ruleset.test.tsx

Samiul-TheSoccerFan · 2025-05-26T18:32:28Z

x-pack/solutions/search/plugins/search_query_rules/public/hooks/use_run_query_ruleset.tsx

+  // Loop through all actions children to gather unique _index values
+  const indices: Set<string> = new Set();
+  if (queryRulesetData?.rules) {
+    for (const rule of queryRulesetData.rules) {
+      if (rule.actions?.docs) {
+        for (const doc of rule.actions.docs) {
+          if (doc._index) {
+            indices.add(doc._index);
+          }
+        }
+      }
+    }
+  }
+
+  // Use the found indices or default to 'my_index'
+  const indecesRuleset = indices.size > 0 ? Array.from(indices).join(',') : 'my_index';
+
+  // Extract match criteria metadata and values from the ruleset
+  const criteriaData = [];
+  if (queryRulesetData?.rules) {
+    for (const rule of queryRulesetData.rules) {
+      if (rule.criteria) {
+        // Handle both single criterion and array of criteria
+        const criteriaArray = Array.isArray(rule.criteria) ? rule.criteria : [rule.criteria];
+        for (const criterion of criteriaArray) {
+          if (
+            criterion.values &&
+            typeof criterion.values === 'object' &&
+            !Array.isArray(criterion.values)
+          ) {
+            // Handle nested values inside criterion.values
+            Object.entries(criterion.values).forEach(([key, value]) => {
+              criteriaData.push({
+                metadata: key,
+                values: value,
+              });
+            });
+          } else {
+            criteriaData.push({
+              metadata: criterion.metadata || null,
+              values: criterion.values || null,
+            });
+          }
+        }
+      }
+    }
+  }


I think we can make it a little performant by using useMemo to make sure we do not do all of these processing for each render.

const { indices, matchCriteria } = useMemo(() => { const indicesSet = new Set<string>(); const criteriaData = []; for (const rule of queryRulesetData?.rules ?? []) { // Collect indices rule.actions?.docs?.forEach((doc) => { if (doc._index) indicesSet.add(doc._index); }); // Collect criteria const criteriaArray = Array.isArray(rule.criteria) ? rule.criteria : rule.criteria ? [rule.criteria] : []; for (const criterion of criteriaArray) { if (criterion.values && typeof criterion.values === 'object' && !Array.isArray(criterion.values)) { Object.entries(criterion.values).forEach(([key, value]) => { criteriaData.push({ metadata: key, values: value }); }); } else { criteriaData.push({ metadata: criterion.metadata || null, values: criterion.values || null, }); } } } const matchCriteria = criteriaData.reduce<Record<string, any>>((acc, { metadata, values }) => { if (metadata && values !== undefined) acc[metadata] = values; return acc; }, {}); return { indices: indicesSet.size > 0 ? Array.from(indicesSet).join(',') : 'my_index', matchCriteria: Object.keys(matchCriteria).length > 0 ? JSON.stringify(matchCriteria, null, 2).split('\n').join('\n ') : `{\n "user_query": "pugs"\n }`, }; }, [queryRulesetData]); const query = dedent` # Query Rules Retriever Example # https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers#rule-retriever GET ${indices}/_search { "retriever": { "rule": { "match_criteria": ${matchCriteria}, "ruleset_ids": [ "${rulesetId}" // An array of one or more unique query ruleset IDs ], "retriever": { "standard": { "query": { "query_string": { "query": "pugs" } } } } } } } `;

This is a probable workaround and it might be missing some typing and comments too.

Thanks @Samiul-TheSoccerFan . I had to tweak a bit your suggestion to avoid some TS issues, let me know if it already works for you:

const { indices, matchCriteria } = useMemo((): { indices: string; matchCriteria: string } => { const indicesSet = new Set<string>(); const criteriaData = []; for (const rule of queryRulesetData?.rules ?? []) { // Collect indices rule.actions?.docs?.forEach((doc) => { if (doc._index) indicesSet.add(doc._index); }); // Collect criteria const criteriaArray = Array.isArray(rule.criteria) ? rule.criteria : rule.criteria ? [rule.criteria] : []; for (const criterion of criteriaArray) { if ( criterion.values && typeof criterion.values === 'object' && !Array.isArray(criterion.values) ) { Object.entries(criterion.values).forEach(([key, value]) => { criteriaData.push({ metadata: key, values: value }); }); } else { criteriaData.push({ metadata: criterion.metadata || null, values: criterion.values || null, }); } } } const reducedCriteria = criteriaData.reduce<Record<string, any>>( (acc, { metadata, values }) => { if (metadata && values !== undefined) acc[metadata] = values; return acc; }, {} ); return { indices: indicesSet.size > 0 ? Array.from(indicesSet).join(',') : 'my_index', matchCriteria: Object.keys(reducedCriteria).length > 0 ? JSON.stringify(reducedCriteria, null, 2).split('\n').join('\n ') : `{\n "user_query": "pugs"\n }`, }; }, [queryRulesetData]);

const TEST_QUERY_RULESET_API_SNIPPET = dedent` # Query Rules Retriever Example # https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers#rule-retriever GET ${indices}/_search { "retriever": { "rule": { "match_criteria": ${matchCriteria}, "ruleset_ids": [ "${rulesetId}" // An array of one or more unique query ruleset IDs ], "retriever": { "standard": { "query": { "query_string": { "query": "pugs" } } } } } } } `;

elasticmachine · 2025-05-27T10:08:53Z

💚 Build Succeeded

Buildkite Build
Commit: a4f6e3b

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`searchQueryRules`	45.6KB	47.1KB	+1.5KB

History

💛 Build #302316 was flaky c147824
💔 Build #302002 failed 08e8ab1

cc @JoseLuisGJ

Samiul-TheSoccerFan

LGTM, thank you for adding the appropriate types.

kibanamachine · 2025-05-28T07:20:49Z

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15294014898

…ils page (elastic#221350) ## Summary Adding Test in Console and Delete from the Ruleset details page: https://github.com/user-attachments/assets/e9db3752-a2e9-4a28-adac-0716809884d6 Test in Console example populating data from the ruleset selected: ![CleanShot 2025-05-23 at 12 18 35@2x](https://github.com/user-attachments/assets/fc94c0e0-f412-4193-9662-9a23703fbfcd) ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 661b96f)

kibanamachine · 2025-05-28T07:29:31Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…om details page (#221350) (#221726) # Backport This will backport the following commits from `main` to `8.19`: - [[Search][Query Rules UI] Test in console and delete ruleset from details page (#221350)](#221350)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: José Luis González <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

…ils page (elastic#221350) ## Summary Adding Test in Console and Delete from the Ruleset details page: https://github.com/user-attachments/assets/e9db3752-a2e9-4a28-adac-0716809884d6 Test in Console example populating data from the ruleset selected: ![CleanShot 2025-05-23 at 12 18 35@2x](https://github.com/user-attachments/assets/fc94c0e0-f412-4193-9662-9a23703fbfcd) ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]>

JoseLuisGJ added 5 commits May 23, 2025 09:48

Adding hook button

2472cdb

Simplified query example

07e58cd

Delete and redirect

c8e44bd

More dynamic search example

2947ab1

Adding comments

08e8ab1

JoseLuisGJ changed the title ~~Test-ruleset-detailspage~~ [Search][Query Rules UI] Test in console and delete ruleset from details page May 23, 2025

JoseLuisGJ self-assigned this May 23, 2025

JoseLuisGJ added release_note:skip Skip the PR/issue when compiling release notes Team:Search backport:version Backport to applied version labels v9.1.0 v8.19.0 labels May 23, 2025

JoseLuisGJ marked this pull request as ready for review May 23, 2025 10:25

JoseLuisGJ requested a review from a team as a code owner May 23, 2025 10:25

Using retriever example

eb6b53b

elasticmachine and others added 2 commits May 26, 2025 11:45

Merge branch 'main' into test-ruleset-detailspage

610f7b7

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

c147824

…-fix'

Samiul-TheSoccerFan reviewed May 26, 2025

View reviewed changes

JoseLuisGJ added 2 commits May 27, 2025 10:12

Fixing tests

9c04112

Memoizing populated request

a4f6e3b

JoseLuisGJ requested a review from Samiul-TheSoccerFan May 27, 2025 11:04

Samiul-TheSoccerFan approved these changes May 27, 2025

View reviewed changes

JoseLuisGJ merged commit 661b96f into elastic:main May 28, 2025
10 checks passed

kibanamachine mentioned this pull request May 28, 2025

[8.19] [Search][Query Rules UI] Test in console and delete ruleset from details page (#221350) #221726

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Search][Query Rules UI] Test in console and delete ruleset from details page #221350

[Search][Query Rules UI] Test in console and delete ruleset from details page #221350

Uh oh!

JoseLuisGJ commented May 23, 2025 •

edited by kibanamachine

Loading

Uh oh!

JoseLuisGJ commented May 26, 2025

Uh oh!

Samiul-TheSoccerFan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Samiul-TheSoccerFan May 26, 2025

Uh oh!

JoseLuisGJ May 27, 2025 •

edited

Loading

Uh oh!

elasticmachine commented May 27, 2025

Uh oh!

Samiul-TheSoccerFan left a comment

Uh oh!

Uh oh!

kibanamachine commented May 28, 2025

Uh oh!

kibanamachine commented May 28, 2025

Uh oh!

Uh oh!

[Search][Query Rules UI] Test in console and delete ruleset from details page #221350

[Search][Query Rules UI] Test in console and delete ruleset from details page #221350

Uh oh!

Conversation

JoseLuisGJ commented May 23, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Identify risks

Uh oh!

JoseLuisGJ commented May 26, 2025

Uh oh!

Samiul-TheSoccerFan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Samiul-TheSoccerFan May 26, 2025

Choose a reason for hiding this comment

Uh oh!

JoseLuisGJ May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented May 27, 2025

💚 Build Succeeded

Metrics [docs]

Async chunks

History

Uh oh!

Samiul-TheSoccerFan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented May 28, 2025

Uh oh!

kibanamachine commented May 28, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Uh oh!

JoseLuisGJ commented May 23, 2025 •

edited by kibanamachine

Loading

JoseLuisGJ May 27, 2025 •

edited

Loading